Completing Function Documentation Comments Using Structural Information

نویسندگان

چکیده

Abstract Source code comments are a cornerstone of software documentation facilitating feature development and maintenance. Well-defined formats, like Javadoc, make it easy to include structural metadata used to, for example, generate manuals. However, the actual usage elements in source has not been studied yet. We investigate which extent these practice whether added information can be leveraged improve tools assisting developers when writing comments. Existing research on comment generation traditionally focuses automatic summaries. recent works have shown promising results supporting authoring through next-word prediction. In this paper, we present an in-depth analysis commenting more than 18K open-source projects written Python Java showing that many elements, particularly parameter return value descriptions indeed widely used. discover while majority rather short at about 6 9 words, several hundred words length. further find tend significantly longer comments, possibly due weakly-typed nature former. Following empirical analysis, extend existing language model with support information, substantially improving Top-1 accuracy predicted (Python 9.6%, 7.8%).

برای دانلود باید عضویت طلایی داشته باشید

برای دانلود متن کامل این مقاله و بیش از 32 میلیون مقاله دیگر ابتدا ثبت نام کنید

اگر عضو سایت هستید لطفا وارد حساب کاربری خود شوید

منابع مشابه

Documentation Page Read Instructions before Completing Form

Timing and speed are suggested to be the two general factors of coordination that differentiate people across a variety of motor movements. This study provides evidence for a third general factor of coordination, that of force control. Subjects that exhibit low variability in reproducing a target force with one effector, such as the finger, show low variability with other effectors, foot or for...

متن کامل

Documentation Page Read Instructions before Completing

A model and a technique developed by Wing and Kristofferson (1973) decomposes variance of timing into that putatively due to a central timekeeper (a clock) and that due to implementation of movement through the motor system. A patient with unilateral cerebellar damage, when attempting to tap out a regular series of intervals, showed a large increase in timing variability for the left hand convi...

متن کامل

Electronic Information Security Documentation

Effective security management depends upon good risk management, which is itself based upon a reliable risk assessment, involving data collection of all the facets influencing system risk. Such data collection is often an extremely onerous task, particularly if a substantial proportion of the required information is not adequately documented. Hence comprehensive, updated information security do...

متن کامل

ذخیره در منابع من


  با ذخیره ی این منبع در منابع من، دسترسی به آن را برای استفاده های بعدی آسان تر کنید

ژورنال

عنوان ژورنال: Empirical Software Engineering

سال: 2023

ISSN: ['1382-3256', '1573-7616']

DOI: https://doi.org/10.1007/s10664-022-10284-6